AMVaultLink object

You are here: COM API reference > Client objects > AMVaultLink object

AMVaultLink object

The AMVaultLink object is a client-side component that implements all functionality required to manage the connection to a vault.

The properties of this object together define a specific context within a specific vault. Applications can use this information to connect to the vault and start a transaction.

Members
Name	Description
BaseLineDisplayName property	The name of the selected baseline.
BaseLineID property	The ID of the selected baseline.
CreateVault property	An AMDocumentRepository. See Remarks.
DataStoreName property	The name of the selected datastore.
DateTimeAsText property	Reserved. See About reserved objects, methods, and properties .
DateTimeUTC property	The selected date value for history mode.
IsBaseline property	See Remarks.
IsWorkMode property	Reserved. See About reserved objects, methods, and properties .
IsWorkPackage property	See Remarks.
LoadFromFile method	Loads settings from a file created with SaveToFile.
LocationAsText property	Reserved. See About reserved objects, methods, and properties .
MachineName property	Selected server machine.
OpenFlags property	Uses AMVAULTLINK_OPEN_DEFAULT.
SaveToFile method	Stores settings to a file.
SectionAddress property	Selected section.
VaultDisplayName property	Display name of the selected vault.
VaultName property	Reserved. See About reserved objects, methods, and properties .
WorkMode property	Should be True. Reserved. See About reserved objects, methods, and properties .
WorkPackageDisplayName property	The display name of the selected work area.
WorkPackageID property	ID of the selected work area.

Remarks

CreateVault

The CreateVault method returns an instance of the AMDocumentRepository object. The repository has been opened using the information set on the AMVaultLink.

The application that calls CreateVault should call CloseRepository before releasing the repository instance.

DateTimeUTC

The AMVaultLink can also define the moment in history to open a vault. The DateTimeUTC property will return the selected DATE value in UTC format. This property will be Empty if the AMVaultLink defines a vault in the present context.

IsBaseline

If a baseline was used to select a moment in history, the IsBaseline property will return True. In this case also the BaseLineDisplayName and BaseLineID properties will return a string value describing the selected baseline.

IsWorkPackage

If a work area is selected, then the IsWorkPackage property will return True. In this case also the WorkPackageDisplayName and WorkPackageID properties will return a string value describing the selected work area.

Related information

Understanding the document repository object

AMOpenVault object